Monitoring / Statistics

Actuator endpoints used to monitor and diagnose the internal configuration of the CAS server are typically exposed over the endpoint /actuator.

Actuator Endpoints

The following endpoints are provided:

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

cas.monitor.endpoints.jdbc.driver-class=org.hsqldb.jdbcDriver

The JDBC driver used to connect to the database.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.password=

The database connection password.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.url=jdbc:hsqldb:mem:cas-hsql-database

The database connection URL.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.user=sa

The database user.

The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.password-encoder.encoding-algorithm=

The encoding algorithm to use such as MD5. Relevant when the type used is DEFAULT or GLIBC_CRYPT.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

cas.monitor.endpoints.jdbc.password-encoder.type=NONE

Define the password encoder type to use. Type may be specified as blank or NONE to disable password encoding. It may also refer to a fully-qualified class name that implements the Spring Security's PasswordEncoder interface if you wish you define your own encoder. The following types may be used:

NONE: No password encoding (i.e. plain-text) takes place.
DEFAULT: Use the DefaultPasswordEncoder of CAS. For message-digest algorithms via character-encoding and encoding-algorithm.
BCRYPT: Use the BCryptPasswordEncoder based on the strength provided and an optional secret.
SCRYPT: Use the SCryptPasswordEncoder.
PBKDF2: Use the Pbkdf2PasswordEncoder based on the strength provided and an optional secret.
STANDARD: Use the StandardPasswordEncoder based on the secret provided.
SSHA: Use the LdapShaPasswordEncoder supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label SHA</code> or SSHA</code> prepended to the encoded hash.
GLIBC_CRYPT: Use the GlibcCryptPasswordEncoder based on the encoding-algorithm, strength provided and an optional secret.
org.example.MyEncoder: An implementation of PasswordEncoder of your own choosing.
file:///path/to/script.groovy: Path to a Groovy script charged with handling password encoding operations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value.}

cas.monitor.endpoints.jdbc.pool.max-size=18

Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

cas.monitor.endpoints.jdbc.pool.max-wait=PT2S

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.

A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

cas.monitor.endpoints.jdbc.pool.min-size=6

Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

cas.monitor.endpoints.jdbc.pool.suspension=false

Whether or not pool suspension is allowed.

There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

cas.monitor.endpoints.jdbc.pool.timeout-millis=1000

The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.

org.apereo.cas.configuration.model.support.ConnectionPoolingProperties.

cas.monitor.endpoints.jdbc.autocommit=false

The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.batch-size=100

A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.data-source-name=

Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.ddl-auto=update

Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to validate or none may be more desirable for production, but any of the following options can be used:

validate: Validate the schema, but make no changes to the database.
update: Update the schema.
create: Create the schema, destroying previous data.
create-drop: Drop the schema at the end of the session.
none: Do nothing.

Note that during a version migration where any schema has changed create-drop will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. validate or none settings are likely the only safe options for production use.

For more info, see this.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.default-catalog=

Qualifies unqualified table names with the given catalog in generated SQL.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.default-schema=

Qualify unqualified table names with the given schema/tablespace in generated SQL.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.dialect=org.hibernate.dialect.HSQLDialect

The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.fail-fast-timeout=1

Set the pool initialization failure timeout.

Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a PoolInitializationException will be thrown.
A value of zero will not prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the connectionTestQuery and connectionInitSql are valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the the pool will start and continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.
A value less than zero will not bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.

Note that if this timeout value is greater than or equal to zero (0), and therefore an initial connection validation is performed, this timeout does not override the connectionTimeout or validationTimeout; they will be honored before this timeout is applied. The default value is one millisecond.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.fetch-size=100

Used to specify number of rows to be fetched in a select query.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.generate-statistics=false

Allow hibernate to generate query statistics.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.health-query=

The SQL query to be executed to test the validity of connections.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.idle-timeout=PT10M

Controls the maximum amount of time that a connection is allowed to sit idle in the pool.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.isolate-internal-queries=false

This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.

Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if #autocommit is disabled.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED

Defines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.leak-threshold=3000

Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy

Fully-qualified name of the class that can control the physical naming strategy of hibernate.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED

Defines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.properties=

Additional settings provided by Hibernate in form of key-value pairs.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.query=

Query to execute in order to authenticate users via JDBC. Example: SELECT username,password,enabled FROM users WHERE username=?

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.role-prefix=

Prefix to add to the role.

org.apereo.cas.configuration.model.core.monitor.JdbcSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8

The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is DEFAULT.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

cas.monitor.endpoints.jdbc.password-encoder.secret=

Secret to use with STANDARD, PBKDF2, BCRYPT, GLIBC_CRYPT password encoders. Secret usually is an optional setting.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

cas.monitor.endpoints.jdbc.password-encoder.strength=16

Strength or number of iterations to use for password hashing. Usually relevant when dealing with PBKDF2 or BCRYPT encoders. Used by GLIBC_CRYPT encoders as well.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

# Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.
# cas.monitor.endpoints.jdbc.pool.max-size=18

# Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.
# cas.monitor.endpoints.jdbc.pool.max-wait=PT2S

# Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.
# cas.monitor.endpoints.jdbc.pool.min-size=6

# Whether or not pool suspension is allowed.
# cas.monitor.endpoints.jdbc.pool.suspension=false

# The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
# cas.monitor.endpoints.jdbc.pool.timeout-millis=1000

# The default auto-commit behavior of connections in the pool.
# cas.monitor.endpoints.jdbc.autocommit=false

# A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
# cas.monitor.endpoints.jdbc.batch-size=100

# Attempts to do a JNDI data source look up for the data source name specified.
# cas.monitor.endpoints.jdbc.data-source-name=

# Hibernate feature to automatically validate and exports DDL to the schema.
# cas.monitor.endpoints.jdbc.ddl-auto=update

# Qualifies unqualified table names with the given catalog in generated SQL.
# cas.monitor.endpoints.jdbc.default-catalog=

# Qualify unqualified table names with the given schema/tablespace in generated SQL.
# cas.monitor.endpoints.jdbc.default-schema=

# The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.
# cas.monitor.endpoints.jdbc.dialect=org.hibernate.dialect.HSQLDialect

# Set the pool initialization failure timeout.
# cas.monitor.endpoints.jdbc.fail-fast-timeout=1

# Used to specify number of rows to be fetched in a select query.
# cas.monitor.endpoints.jdbc.fetch-size=100

# Allow hibernate to generate query statistics.
# cas.monitor.endpoints.jdbc.generate-statistics=false

# The SQL query to be executed to test the validity of connections.
# cas.monitor.endpoints.jdbc.health-query=

# Controls the maximum amount of time that a connection is allowed to sit idle in the pool.
# cas.monitor.endpoints.jdbc.idle-timeout=PT10M

# This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.
# cas.monitor.endpoints.jdbc.isolate-internal-queries=false

# Defines the isolation level for transactions.
# cas.monitor.endpoints.jdbc.isolation-level-name=ISOLATION_READ_COMMITTED

# Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
# cas.monitor.endpoints.jdbc.leak-threshold=3000

# Fully-qualified name of the class that can control the physical naming strategy of hibernate.
# cas.monitor.endpoints.jdbc.physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy

# Defines the propagation behavior for transactions.
# cas.monitor.endpoints.jdbc.propagation-behavior-name=PROPAGATION_REQUIRED

# Additional settings provided by Hibernate in form of key-value pairs.
# cas.monitor.endpoints.jdbc.properties=

# Query to execute in order to authenticate users via JDBC.
# cas.monitor.endpoints.jdbc.query=

# Prefix to add to the role.
# cas.monitor.endpoints.jdbc.role-prefix=

# The encoding algorithm to use such as 'UTF-8'.
# cas.monitor.endpoints.jdbc.password-encoder.character-encoding=UTF-8

# Secret to use with {@code STANDARD}, {@code PBKDF2}, {@code BCRYPT}, {@code GLIBC_CRYPT} password encoders.
# cas.monitor.endpoints.jdbc.password-encoder.secret=

# Strength or number of iterations to use for password hashing.
# cas.monitor.endpoints.jdbc.password-encoder.strength=16

Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.

If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:

package org.example.cas;

import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;

public class MyEncoder extends AbstractPasswordEncoder {
    @Override
    protected byte[] encode(CharSequence rawPassword, byte[] salt) {
        return ...
    }
}

If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:

import java.util.*

byte[] run(final Object... args) {
    def rawPassword = args[0]
    def generatedSalt = args[1]
    def logger = args[2]
    def casApplicationContext = args[3]

    logger.debug("Encoding password...")
    return ...
}

Boolean matches(final Object... args) {
    def rawPassword = args[0]
    def encodedPassword = args[1]
    def logger = args[2]
    def casApplicationContext = args[3]

   logger.debug("Does match or not ?");
   return ...

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.ldap.base-dn=

Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: subtreeA,dc=example,dc=net|subtreeC,dc=example,dc=net.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.bind-credential=

The bind credential to use when connecting to LDAP.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.bind-dn=

The bind DN to use when connecting to LDAP. LDAP connection configuration injected into the LDAP connection pool can be initialized with the following parameters:

bindDn/bindCredential provided - Use the provided credentials to bind when initializing connections.
bindDn/bindCredential set to * - Use a fast-bind strategy to initialize the pool.
bindDn/bindCredential set to blank - Skip connection initializing; perform operations anonymously.
SASL mechanism provided - Use the given SASL mechanism to bind when initializing connections.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.ldap-url=

The LDAP url to the server. More than one may be specified, separated by space and/or comma.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.search-filter=

User filter to use for searching. Syntax is cn=user or cn=0. You may also provide an external groovy script in the syntax of file:/path/to/GroovyScript.groovy to fully build the final filter template dynamically.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.type=AUTHENTICATED

The authentication type.

AD - Users authenticate with sAMAccountName.
AUTHENTICATED - Manager bind/search type of authentication. If principalAttributePassword</code> is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.
ANONYMOUS: Similar semantics as AUTHENTICATED except no bindDn and bindCredential may be specified to initialize the connection. If principalAttributePassword is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.
DIRECT: Direct Bind - Compute user DN from format string and perform simple bind. This is relevant when no search is required to compute the DN needed for a bind operation. Use cases for this type are: 1) All users are under a single branch in the directory, e.g. ou=Users,dc=example,dc=org. 2) The username provided on the CAS login form is part of the DN, e.g. uid=%s,ou=Users,dc=example,dc=org.

Available values are as follows:

AD: Active Directory.
AUTHENTICATED: Authenticated Search.
DIRECT: Direct Bind.
ANONYMOUS: Anonymous Search.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.ldap-authz.allow-multiple-results=false

Indicate whether the LDAP search query is allowed to return multiple entries.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.ldap-authz.base-dn=

Base DN to start the search.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.ldap-authz.group-attribute=

Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles. The final value is always prefixed with #groupPrefix. This is useful in scenarios where you wish to grant access to a resource to all users who a member of a given group.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.ldap-authz.group-base-dn=

Base DN to start the search looking for groups.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.ldap-authz.group-filter=

Search filter to begin looking for groups.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.ldap-authz.group-prefix=

A prefix that is prepended to the group attribute value to construct an authorized role.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.ldap-authz.role-attribute=uugid

Attribute expected to be found on the entry whose value is going to be used to construct roles. The final value is always prefixed with #rolePrefix. This is useful in scenarios where you wish to grant access to a resource to all users who carry a special attribute.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.ldap-authz.role-prefix=ROLE_

Prefix for the role.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.ldap-authz.search-filter=

LDAP search filter to locate accounts.

org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=

The Attribute name case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names=

The Attribute names.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=

The Attribute value case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change=

The Dn case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=

The Add if exists.

org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

The Dn attribute name.

org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names=

The Attribute names.

org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=

The Merge attribute name.

org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn=

The Base dn.

org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

The Group filter.

org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes=

The Merge attributes.

org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute=

The Search attribute.

org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.search-entry-handlers[0].type=

The type of search entry handler to choose. Available values are as follows:

ACTIVE_DIRECTORY: Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc.
OBJECT_GUID: Object guid search entry handler. Handles the objectGUID attribute fetching and conversion.
OBJECT_SID: Object sid search entry handler. Handles the objectSid attribute fetching and conversion.
CASE_CHANGE: Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.
DN_ATTRIBUTE_ENTRY: DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020.
MERGE: Merge search entry handler. Merges the values of one or more attributes into a single attribute.
PRIMARY_GROUP: Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the memberOf attribute of the original search entry.
RANGE_ENTRY: Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches.
RECURSIVE_ENTRY: Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry.

org.apereo.cas.configuration.model.support.ldap.LdapSearchEntryHandlersProperties.

cas.monitor.endpoints.ldap.validator.attribute-name=objectClass

Attribute name to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

cas.monitor.endpoints.ldap.validator.attribute-value=top

Attribute values to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

cas.monitor.endpoints.ldap.validator.base-dn=

Base DN to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

cas.monitor.endpoints.ldap.validator.dn=

DN to compare to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

cas.monitor.endpoints.ldap.validator.scope=OBJECT

Search scope to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

cas.monitor.endpoints.ldap.validator.search-filter=(objectClass=*)

Search filter to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

cas.monitor.endpoints.ldap.validator.type=search

Determine the LDAP validator type. The following LDAP validators can be used to test connection health status:

search: Validates a connection is healthy by performing a search operation. Validation is considered successful if the search result size is greater than zero.
none: No validation takes place.
compare: Validates a connection is healthy by performing a compare operation.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

cas.monitor.endpoints.ldap.allow-multiple-dns=false

Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.allow-multiple-entries=false

Set if multiple Entries are allowed.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.binary-attributes=

Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.block-wait-time=PT3S

The length of time the pool will block. By default the pool will block indefinitely and there is no guarantee that waiting threads will be serviced in the order in which they made their request. This option should be used with a blocking connection pool when you need to control the exact number of connections that can be created

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.connect-timeout=PT5S

Sets the maximum amount of time that connects will block.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.connection-strategy=

If multiple URLs are provided as the ldapURL this describes how each URL will be processed.

ACTIVE_PASSIVE First LDAP will be used for every request unless it fails and then the next shall be used.
ROUND_ROBIN For each new connection the next url in the list will be used.
RANDOM For each new connection a random LDAP url will be selected.
DNS_SRV LDAP urls based on DNS SRV records of the configured/given LDAP url will be used.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.deref-aliases=

Define how aliases are de-referenced. Accepted values are:

NEVER
SEARCHING: dereference when searching the entries beneath the starting point but not when searching for the starting entry.
FINDING: dereference when searching for the starting entry but not when searching the entries beneath the starting point.
ALWAYS: dereference when searching for the starting entry and when searching the entries beneath the starting point.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.disable-pooling=false

Whether to use a pooled connection factory in components.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.dn-format=

Specify the dn format accepted by the AD authenticator, etc. Example format might be uid=%s,ou=people,dc=example,dc=org.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.enhance-with-entry-resolver=true

Whether specific search entry resolvers need to be set on the authenticator, or the default should be used.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.fail-fast=true

Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.follow-referrals=true

Set if search referrals should be followed.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.hostname-verifier=DEFAULT

Hostname verification options. Available values are as follows:

DEFAULT: Default option, forcing verification.
ANY: Skip hostname verification and allow all.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.idle-time=PT10M

Removes connections from the pool based on how long they have been idle in the available queue. Prunes connections that have been idle for more than the indicated amount.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.keystore=

Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.keystore-password=

Keystore password.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.keystore-type=

The type of keystore. PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.max-pool-size=10

Maximum LDAP connection pool size which the pool can use to grow.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.min-pool-size=3

Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.name=

Name of the LDAP handler.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.page-size=0

Request that the server return results in batches of a specific size. See RFC 2696. This control is often used to work around server result size limits. A negative/zero value disables paged requests.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.pool-passivator=BIND

You may receive unexpected LDAP failures, when CAS is configured to authenticate using DIRECT or AUTHENTICATED types and LDAP is locked down to not allow anonymous binds/searches. Every second attempt with a given LDAP connection from the pool would fail if it was on the same connection as a failed login attempt, and the regular connection validator would similarly fail. When a connection is returned back to a pool, it still may contain the principal and credentials from the previous attempt. Before the next bind attempt using that connection, the validator tries to validate the connection again but fails because it’s no longer trying with the configured bind credentials but with whatever user DN was used in the previous step. Given the validation failure, the connection is closed and CAS would deny access by default. Passivators attempt to reconnect to LDAP with the configured bind credentials, effectively resetting the connection to what it should be after each bind request. Furthermore if you are seeing errors in the logs that resemble a 'Operation exception encountered, reopening connection' type of message, this usually is an indication that the connection pool’s validation timeout established and created by CAS is greater than the timeout configured in the LDAP server, or more likely, in the load balancer in front of the LDAP servers. You can adjust the LDAP server session’s timeout for connections, or you can teach CAS to use a validity period that is equal or less than the LDAP server session’s timeout. Accepted values are:

NONE: No passivation takes place.
BIND: The default behavior which passivates a connection by performing a bind operation on it. This option requires the availability of bind credentials when establishing connections to LDAP.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.principal-attribute-password=

If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.

For the anonymous authentication type, if principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.prune-period=PT2H

Removes connections from the pool based on how long they have been idle in the available queue. Run the pruning process at the indicated interval.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.response-timeout=PT5S

Duration of time to wait for responses.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.sasl-authorization-id=

SASL authorization id.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.sasl-mechanism=

The SASL mechanism.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.sasl-mutual-auth=

SASL mutual auth is enabled?

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.sasl-quality-of-protection=

SASL quality of protected.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.sasl-realm=

The SASL realm.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.sasl-security-strength=

SASL security strength.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.search-entry-handlers=

Search handlers.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.subtree-search=true

Whether subtree searching is allowed.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.trust-certificates=

Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.trust-manager=

Trust Manager options. Trust managers are responsible for managing the trust material that is used when making LDAP trust decisions, and for deciding whether credentials presented by a peer should be accepted. Accepted values are: *

DEFAULT: Enable and force the default JVM trust managers.
ANY: Trust any client or server.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.trust-store=

Path to the keystore used to determine which certificates or certificate authorities should be trusted. Used when connecting to an LDAP server via LDAPS or startTLS connection. If left blank, the default truststore for the Java runtime is used.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.trust-store-password=

Password needed to open the truststore.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.trust-store-type=

The type of trust keystore that determines which certificates or certificate authorities are trusted. Types depend on underlying java platform, typically PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.use-start-tls=false

Whether TLS should be used and enabled when establishing the connection.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.validate-on-checkout=true

Whether connections should be validated when loaned out from the pool.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.validate-period=PT5M

Period at which pool should be validated.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.validate-periodically=true

Whether connections should be validated periodically when the pool is idle.

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.ldap.validate-timeout=PT5S

Period at which validation operations may time out.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.monitor.LdapSecurityActuatorEndpointsMonitorProperties.

# Indicate whether the LDAP search query is allowed to return multiple entries.
# cas.monitor.endpoints.ldap.ldap-authz.allow-multiple-results=false

# Base DN to start the search.
# cas.monitor.endpoints.ldap.ldap-authz.base-dn=

# Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles.
# cas.monitor.endpoints.ldap.ldap-authz.group-attribute=

# Base DN to start the search looking for groups.
# cas.monitor.endpoints.ldap.ldap-authz.group-base-dn=

# Search filter to begin looking for groups.
# cas.monitor.endpoints.ldap.ldap-authz.group-filter=

# A prefix that is prepended to the group attribute value to construct an authorized role.
# cas.monitor.endpoints.ldap.ldap-authz.group-prefix=

# Attribute expected to be found on the entry whose value is going to be used to construct roles.
# cas.monitor.endpoints.ldap.ldap-authz.role-attribute=uugid

# Prefix for the role.
# cas.monitor.endpoints.ldap.ldap-authz.role-prefix=ROLE_

# LDAP search filter to locate accounts.
# cas.monitor.endpoints.ldap.ldap-authz.search-filter=

# The Attribute name case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=

# The Attribute names.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names=

# The Attribute value case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=

# The Dn case change.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change=

# The Add if exists.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=

# The Dn attribute name.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

# The Attribute names.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names=

# The Merge attribute name.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=

# The Base dn.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn=

# The Group filter.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

# The Merge attributes.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes=

# The Search attribute.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute=

# The type of search entry handler to choose.
# cas.monitor.endpoints.ldap.search-entry-handlers[0].type=

# Attribute name to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.attribute-name=objectClass

# Attribute values to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.attribute-value=top

# Base DN to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.base-dn=

# DN to compare to use for the compare validator.
# cas.monitor.endpoints.ldap.validator.dn=

# Search scope to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.scope=OBJECT

# Search filter to use for the search request of the search validator.
# cas.monitor.endpoints.ldap.validator.search-filter=(objectClass=*)

# Determine the LDAP validator type.
# cas.monitor.endpoints.ldap.validator.type=search

# Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.
# cas.monitor.endpoints.ldap.allow-multiple-dns=false

# Set if multiple Entries are allowed.
# cas.monitor.endpoints.ldap.allow-multiple-entries=false

# Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.
# cas.monitor.endpoints.ldap.binary-attributes=

# The length of time the pool will block.
# cas.monitor.endpoints.ldap.block-wait-time=PT3S

# Sets the maximum amount of time that connects will block.
# cas.monitor.endpoints.ldap.connect-timeout=PT5S

# If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
# cas.monitor.endpoints.ldap.connection-strategy=

# Define how aliases are de-referenced.
# cas.monitor.endpoints.ldap.deref-aliases=

# Whether to use a pooled connection factory in components.
# cas.monitor.endpoints.ldap.disable-pooling=false

# Specify the dn format accepted by the AD authenticator, etc.
# cas.monitor.endpoints.ldap.dn-format=

# Whether specific search entry resolvers need to be set on the authenticator, or the default should be used.
# cas.monitor.endpoints.ldap.enhance-with-entry-resolver=true

# Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.
# cas.monitor.endpoints.ldap.fail-fast=true

# Set if search referrals should be followed.
# cas.monitor.endpoints.ldap.follow-referrals=true

# Hostname verification options.
# cas.monitor.endpoints.ldap.hostname-verifier=DEFAULT

# Removes connections from the pool based on how long they have been idle in the available queue.
# cas.monitor.endpoints.ldap.idle-time=PT10M

# Path to the keystore used for SSL connections.
# cas.monitor.endpoints.ldap.keystore=

# Keystore password.
# cas.monitor.endpoints.ldap.keystore-password=

# The type of keystore.
# cas.monitor.endpoints.ldap.keystore-type=

# Maximum LDAP connection pool size which the pool can use to grow.
# cas.monitor.endpoints.ldap.max-pool-size=10

# Minimum LDAP connection pool size.
# cas.monitor.endpoints.ldap.min-pool-size=3

# Name of the LDAP handler.
# cas.monitor.endpoints.ldap.name=

# Request that the server return results in batches of a specific size.
# cas.monitor.endpoints.ldap.page-size=0

# You may receive unexpected LDAP failures, when CAS is configured to authenticate using {@code DIRECT} or {@code AUTHENTICATED} types and LDAP is locked down to not allow anonymous binds/searches.
# cas.monitor.endpoints.ldap.pool-passivator=BIND

# If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.
# cas.monitor.endpoints.ldap.principal-attribute-password=

# Removes connections from the pool based on how long they have been idle in the available queue.
# cas.monitor.endpoints.ldap.prune-period=PT2H

# Duration of time to wait for responses.
# cas.monitor.endpoints.ldap.response-timeout=PT5S

# SASL authorization id.
# cas.monitor.endpoints.ldap.sasl-authorization-id=

# The SASL mechanism.
# cas.monitor.endpoints.ldap.sasl-mechanism=

# SASL mutual auth is enabled?
# cas.monitor.endpoints.ldap.sasl-mutual-auth=

# SASL quality of protected.
# cas.monitor.endpoints.ldap.sasl-quality-of-protection=

# The SASL realm.
# cas.monitor.endpoints.ldap.sasl-realm=

# SASL security strength.
# cas.monitor.endpoints.ldap.sasl-security-strength=

# Search handlers.
# cas.monitor.endpoints.ldap.search-entry-handlers=

# Whether subtree searching is allowed.
# cas.monitor.endpoints.ldap.subtree-search=true

# Path of the trust certificates to use for the SSL connection.
# cas.monitor.endpoints.ldap.trust-certificates=

# Trust Manager options.
# cas.monitor.endpoints.ldap.trust-manager=

# Path to the keystore used to determine which certificates or certificate authorities should be trusted.
# cas.monitor.endpoints.ldap.trust-store=

# Password needed to open the truststore.
# cas.monitor.endpoints.ldap.trust-store-password=

# The type of trust keystore that determines which certificates or certificate authorities are trusted.
# cas.monitor.endpoints.ldap.trust-store-type=

# Whether TLS should be used and enabled when establishing the connection.
# cas.monitor.endpoints.ldap.use-start-tls=false

# Whether connections should be validated when loaned out from the pool.
# cas.monitor.endpoints.ldap.validate-on-checkout=true

# Period at which pool should be validated.
# cas.monitor.endpoints.ldap.validate-period=PT5M

# Whether connections should be validated periodically when the pool is idle.
# cas.monitor.endpoints.ldap.validate-periodically=true

# Period at which validation operations may time out.
# cas.monitor.endpoints.ldap.validate-timeout=PT5S

LDAP search filters can point to an external Groovy script to dynamically construct the final filter template.

The script itself may be designed as:

import org.ldaptive.*
import org.springframework.context.*

def run(Object[] args) {
    def filter = (FilterTemplate) args[0]
    def parameters = (Map) args[1]
    def applicationContext = (ApplicationContext) args[2]
    def logger = args[3]

    logger.info("Configuring LDAP filter")
    filter.setFilter("uid=something")
}

The following parameters are passed to the script:

Parameter	Description
`filter`	`FilterTemplate` to be updated by the script and used for the LDAP query.
`parameters`	Map of query parameters which may be used to construct the final filter.
`applicationContext`	Reference to the Spring `ApplicationContext` reference.
`logger`	The object responsible for issuing log messages such as `logger.info(...)`.

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.jaas.login-config=

JAAS login resource file.

org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jaas.login-context-name=

The login context name should coincide with a given index in the login config specified. This name is used as the index to the configuration specified in the login config property.

 JAASTest  org.springframework.security.authentication.jaas.TestLoginModule required; </code>;

In the above example, JAASTest should be set as the context name.

org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.jaas.refresh-configuration-on-startup=true

If set, a call to Configuration#refresh() will be made by #configureJaas(Resource) method.

org.apereo.cas.configuration.model.core.monitor.JaasSecurityActuatorEndpointsMonitorProperties.

CAS version information and other system traits.

Map

InfoEndpoint.info()

org.springframework.boot.actuate.info.InfoEndpoint

CAS, being a Spring-Boot application at heart, includes a number of endpoints to help you monitor and manage the server when it’s pushed to production. You can choose to manage and monitor the deployment using HTTP endpoints, referred to as actuators.

In essence, actuator endpoints bring production-ready features to CAS. Monitoring a running CAS instance, gathering metrics, understanding traffic or the state of our database becomes trivial with such endpoints. The main benefit of these endpoints is that we can get production grade tools without having to actually implement these features ourselves. Actuators are mainly used to expose operational information about the running application – health, metrics, etc. These are HTTP endpoints or JMX beans to enable us to interact with it.

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

Note that by default the only endpoints exposed over the web are info, status, health and configurationMetadata. Other endpoints need to be explicitly enabled and then exposed over the web in CAS settings in order to allow access.

To enable and expose an actuator endpoint:

management.endpoint.info.enabled=true
management.endpoints.web.exposure.include=info

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.info.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

Base path for Web endpoints. Relative to the servlet context path (server.servlet.context-path) or WebFlux base path (spring.webflux.base-path) when the management server is sharing the main server port. Relative to the management server base path (management.server.base-path) when a separate management server port (management.server.port) is configured.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

Comma-separated list of origin patterns to allow. Unlike allowed origins which only supports '*', origin patterns are more flexible (for example 'https://*.example.com') and can be used when credentials are allowed. When no allowed origin patterns or allowed origins are set, CORS support is disabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

Comma-separated list of origins to allow. '*' allows all origins. When credentials are allowed, '*' cannot be used and origin patterns should be configured instead. When no allowed origins or allowed origin patterns are set, CORS support is disabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

# Maximum time that a response can be cached.
# management.endpoint.health.cache.time-to-live=0ms

# Whether to enable the health endpoint.
# management.endpoint.health.enabled=true

# Health endpoint groups.
# management.endpoint.health.group=

# Whether to enable liveness and readiness probes.
# management.endpoint.health.probes.enabled=false

# Roles used to determine whether or not a user is authorized to be shown details.
# management.endpoint.health.roles=

# When to show components.
# management.endpoint.health.show-components=

# When to show full health details.
# management.endpoint.health.show-details=never

# Mapping of health statuses to HTTP status codes.
# management.endpoint.health.status.http-mapping=

# Comma-separated list of health statuses in order of severity.
# management.endpoint.health.status.order=["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]

# Whether to enable or disable all endpoints by default.
# management.endpoints.enabled-by-default=

# Endpoints JMX domain name.
# management.endpoints.jmx.domain=org.springframework.boot

# Endpoint IDs that should be excluded or '*' for all.
# management.endpoints.jmx.exposure.exclude=

# Endpoint IDs that should be included or '*' for all.
# management.endpoints.jmx.exposure.include=*

# Additional static properties to append to all ObjectNames of MBeans representing Endpoints.
# management.endpoints.jmx.static-names=

# Whether unique runtime object names should be ensured.
# management.endpoints.jmx.unique-names=

# Whether to transparently migrate legacy endpoint IDs.
# management.endpoints.migrate-legacy-ids=false

# Base path for Web endpoints.
# management.endpoints.web.base-path=/actuator

# Whether credentials are supported.
# management.endpoints.web.cors.allow-credentials=

# Comma-separated list of headers to allow in a request. '*' allows all headers.
# management.endpoints.web.cors.allowed-headers=

# Comma-separated list of methods to allow. '*' allows all methods.
# management.endpoints.web.cors.allowed-methods=

# Comma-separated list of origin patterns to allow.
# management.endpoints.web.cors.allowed-origin-patterns=

# Comma-separated list of origins to allow. '*' allows all origins.
# management.endpoints.web.cors.allowed-origins=

# Comma-separated list of headers to include in a response.
# management.endpoints.web.cors.exposed-headers=

# How long the response from a pre-flight request can be cached by clients.
# management.endpoints.web.cors.max-age=1800s

# Whether the discovery page is enabled.
# management.endpoints.web.discovery.enabled=true

# Endpoint IDs that should be excluded or '*' for all.
# management.endpoints.web.exposure.exclude=

# Endpoint IDs that should be included or '*' for all.
# management.endpoints.web.exposure.include=["health"]

# Mapping between endpoint IDs and the path that should expose them.
# management.endpoints.web.path-mapping=

# Allows to enable/disable binder's' health indicators.
# management.health.binders.enabled=true

# Whether to enable Cassandra health check.
# management.health.cassandra.enabled=true

# Whether to enable Couchbase health check.
# management.health.couchbase.enabled=true

# Timeout for getting the Bucket information from the server.
# management.health.couchbase.timeout=1000ms

# Whether to enable database health check.
# management.health.db.enabled=true

# Whether to ignore AbstractRoutingDataSources when creating database health indicators.
# management.health.db.ignore-routing-data-sources=false

# Whether to enable default health indicators.
# management.health.defaults.enabled=true

# Whether to enable disk space health check.
# management.health.diskspace.enabled=true

# Path used to compute the available disk space.
# management.health.diskspace.path=

# Minimum disk space that should be available.
# management.health.diskspace.threshold=10MB

# Whether to enable Elasticsearch health check.
# management.health.elasticsearch.enabled=true

# Comma-separated index names.
# management.health.elasticsearch.indices=

# Time to wait for a response from the cluster.
# management.health.elasticsearch.response-timeout=

# Whether to enable InfluxDB health check.
# management.health.influxdb.enabled=true

# Whether to enable JMS health check.
# management.health.jms.enabled=true

# Whether to enable LDAP health check.
# management.health.ldap.enabled=true

# Whether to enable liveness state health check.
# management.health.livenessstate.enabled=false

# Whether to enable Mail health check.
# management.health.mail.enabled=true

# Whether to enable MongoDB health check.
# management.health.mongo.enabled=true

# Whether to enable Neo4j health check.
# management.health.neo4j.enabled=true

# Whether to enable ping health check.
# management.health.ping.enabled=true

# Whether to enable liveness and readiness probes.
# management.health.probes.enabled=false

# Whether to enable RabbitMQ health check.
# management.health.rabbit.enabled=true

# Whether to enable readiness state health check.
# management.health.readinessstate.enabled=false

# Whether to enable Redis health check.
# management.health.redis.enabled=true

# Enable the health endpoint for the refresh scope.
# management.health.refresh.enabled=true

# Whether to enable Solr health check.
# management.health.solr.enabled=true

# 
# management.health.status.order=["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]

# Enable the health endpoint for zookeeper.
# management.health.zookeeper.enabled=true

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

For basic authentication, the default username is casuser. The password may be automatically generated at startup and displayed in CAS logs if it is left undefined in CAS settings. Additional sources may also be defined that would authenticate the request via JAAS, LDAP, JDBC, etc.

Once endpoints are enabled and exposed, the security of all provided endpoints is handled by the Spring Security project. Protection and access to each endpoint is controlled via CAS settings individually such that you may decide a specific security level and method of authentication for each endpoint independently.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Analyze application startup events, beans and load and optionally report events to Java Flight Recorder.

StartupResponse

StartupEndpoint.startupSnapshot()

org.springframework.boot.actuate.startup.StartupEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.startup.enabled=true
management.endpoints.web.exposure.include=startup

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.startup.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Analyze application startup events, beans and load and optionally report events to Java Flight Recorder.

StartupResponse

StartupEndpoint.startup()

org.springframework.boot.actuate.startup.StartupEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.startup.enabled=true
management.endpoints.web.exposure.include=startup

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.startup.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Produces a thread dump for the running CAS server.

ThreadDumpDescriptor

ThreadDumpEndpoint.threadDump()

org.springframework.boot.actuate.management.ThreadDumpEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.threaddump.enabled=true
management.endpoints.web.exposure.include=threaddump

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.threaddump.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Produces a thread dump for the running CAS server.

`String`	`text/plain;charset=UTF-8`
`ThreadDumpEndpoint.textThreadDump()`
`org.springframework.boot.actuate.management.ThreadDumpEndpoint`

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.threaddump.enabled=true
management.endpoints.web.exposure.include=threaddump

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.threaddump.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Reports back general health status of the system, produced by various monitors.

HealthComponent

HealthEndpoint.health()

org.springframework.boot.actuate.health.HealthEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.health.enabled=true
management.endpoints.web.exposure.include=health

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.health.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

The health endpoint may also be configured to show details via the following conditions:

URL	Description
`never`	Never display details of health monitors.
`always`	Always display details of health monitors.
`when-authorized`	Details are only shown to authorized users. Authorized roles can be configured using `management.endpoint.health.roles`.

The results and details of the health endpoints are produced by a number of health indicator components that may monitor different systems, such as LDAP connection pools, database connections, etc.

# management.health.[indicator].enabled=false|true

The following health indicator names are available, given the presence of the appropriate CAS feature:

Health Indicator	Description
`memoryHealthIndicator`	Reports back on the health status of CAS JVM memory usage, etc.
`systemHealthIndicator`	Reports back on the health of the system of the CAS server.(Load, Uptime, Heap, CPU etc.)
`sessionHealthIndicator`	Reports back on the health status of CAS tickets and SSO session usage.
`duoSecurityHealthIndicator`	Reports back on the health status of Duo Security APIs.
`ehcacheHealthIndicator`	Reports back on the health status of Ehcache caches.
`hazelcastHealthIndicator`	Reports back on the health status of Hazelcast caches.
`dataSourceHealthIndicator`	Reports back on the health status of JDBC connections.
`pooledLdapConnectionFactoryHealthIndicator`	Reports back on the health status of LDAP connection pools.
`memcachedHealthIndicator`	Reports back on the health status of Memcached connections.
`mongoHealthIndicator`	Reports back on the health status of MongoDb connections.
`samlRegisteredServiceMetadataHealthIndicator`	Reports back on the health status of SAML2 service provider metadata sources.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Reports back general health status of the system, produced by various monitors.

HealthComponent

HealthEndpoint.healthForPath(java.lang.String…)

org.springframework.boot.actuate.health.HealthEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.health.enabled=true
management.endpoints.web.exposure.include=health

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.health.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

The health endpoint may also be configured to show details via the following conditions:

URL	Description
`never`	Never display details of health monitors.
`always`	Always display details of health monitors.
`when-authorized`	Details are only shown to authorized users. Authorized roles can be configured using `management.endpoint.health.roles`.

The results and details of the health endpoints are produced by a number of health indicator components that may monitor different systems, such as LDAP connection pools, database connections, etc.

# management.health.[indicator].enabled=false|true

The following health indicator names are available, given the presence of the appropriate CAS feature:

Health Indicator	Description
`memoryHealthIndicator`	Reports back on the health status of CAS JVM memory usage, etc.
`systemHealthIndicator`	Reports back on the health of the system of the CAS server.(Load, Uptime, Heap, CPU etc.)
`sessionHealthIndicator`	Reports back on the health status of CAS tickets and SSO session usage.
`duoSecurityHealthIndicator`	Reports back on the health status of Duo Security APIs.
`ehcacheHealthIndicator`	Reports back on the health status of Ehcache caches.
`hazelcastHealthIndicator`	Reports back on the health status of Hazelcast caches.
`dataSourceHealthIndicator`	Reports back on the health status of JDBC connections.
`pooledLdapConnectionFactoryHealthIndicator`	Reports back on the health status of LDAP connection pools.
`memcachedHealthIndicator`	Reports back on the health status of Memcached connections.
`mongoHealthIndicator`	Reports back on the health status of MongoDb connections.
`samlRegisteredServiceMetadataHealthIndicator`	Reports back on the health status of SAML2 service provider metadata sources.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Runtime metrics and stats.

MetricResponse

MetricsEndpoint.metric(java.lang.String,java.util.List)

org.springframework.boot.actuate.metrics.MetricsEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

Navigating to this endpoint displays a list of available meter names. You can drill down to view information about a particular meter by providing its name as a selector, e.g. /metrics/jvm.memory.max. The name you use here should match the name used in the code, not the name after it has been naming-convention normalized for a monitoring system it is shipped to. You can also add any number of tag=KEY:VALUE query parameters to the end of the URL to dimensionally drill down on a meter, e.g. /metrics/jvm.memory.max?tag=area:nonheap` The reported measurements are the sum of the statistics of all meters matching the meter name and any tags that have been applied. So in the example above, the returned "Value" statistic is the sum of the maximum memory footprints of "Code Cache", "Compressed Class Space", and "Metaspace" areas of the heap. If you just wanted to see the maximum size for the "Metaspace", you could add an additional tag=id:Metaspace, i.e. /metrics/jvm.memory.max?tag=area:nonheap&tag=id:Metaspace.

To enable and expose an actuator endpoint:

management.endpoint.metrics.enabled=true
management.endpoints.web.exposure.include=metrics

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.metrics.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Runtime metrics and stats.

ListNamesResponse

MetricsEndpoint.listNames()

org.springframework.boot.actuate.metrics.MetricsEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.metrics.enabled=true
management.endpoints.web.exposure.include=metrics

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.metrics.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Displays HTTP trace information (by default, the last 100 HTTP request-response exchanges).

HttpTraceDescriptor

HttpTraceEndpoint.traces()

org.springframework.boot.actuate.trace.http.HttpTraceEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.httptrace.enabled=true
management.endpoints.web.exposure.include=httptrace

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.httptrace.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Describes how requests are mapped and handled by CAS.

ApplicationMappings

MappingsEndpoint.mappings()

org.springframework.boot.actuate.web.mappings.MappingsEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.mappings.enabled=true
management.endpoints.web.exposure.include=mappings

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.mappings.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Displays the scheduled tasks in CAS.

ScheduledTasksReport

ScheduledTasksEndpoint.scheduledTasks()

org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.scheduledtasks.enabled=true
management.endpoints.web.exposure.include=scheduledtasks

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.scheduledtasks.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Report back scheduled groups and triggers for Quartz.

QuartzReport

QuartzEndpoint.quartzReport()

org.springframework.boot.actuate.quartz.QuartzEndpoint

Actuator endpoints are presented by CAS in two categories:

Those that are owned and defined by the CAS project.
Those that are owned and defined by third-party projects, frameworks and libraries such as Spring Boot.

Exposed Endpoints

To enable and expose an actuator endpoint:

management.endpoint.quartz.enabled=true
management.endpoints.web.exposure.include=quartz

# Choose the proper security access level...
# cas.monitor.endpoints.endpoint.quartz.access=PERMIT

The following settings and properties are available from the CAS configuration catalog:

cas.monitor.endpoints.form-login-enabled=false

Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointsMonitorProperties.

cas.monitor.endpoints.endpoint.[key].access=

Define the security access level of the endpoint. Available values are as follows:

PERMIT: Allow open access to the endpoint.
ANONYMOUS: Allow anonymous access to the endpoint.
DENY: Block access to the endpoint.
AUTHENTICATED: Require authenticated access to the endpoint.
ROLE: Require authenticated access to the endpoint along with a role requirement.
AUTHORITY: Require authenticated access to the endpoint along with an authority requirement.
IP_ADDRESS: Require authenticated access to the endpoint using a collection of IP addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-authorities=

Required user authorities.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-ip-addresses=

Required ip addresses.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

cas.monitor.endpoints.endpoint.[key].required-roles=

Required user roles.

org.apereo.cas.configuration.model.core.monitor.ActuatorEndpointProperties.

Endpoints may be mapped to custom arbitrary endpoints. For example, to remap the health endpoint to healthcheck, specify the following settings:

# management.endpoints.web.path-mapping.health=healthcheck

management.endpoint.health.cache.time-to-live=0ms

Maximum time that a response can be cached.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.enabled=true

Whether to enable the health endpoint.

org.springframework.boot.actuate.health.HealthEndpoint.

management.endpoint.health.group=

Health endpoint groups.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.probes.enabled=false

Whether to enable liveness and readiness probes.

management.endpoint.health.roles=

Roles used to determine whether or not a user is authorized to be shown details. When empty, all authenticated users are authorized.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-components=

When to show components. If not specified the 'show-details' setting will be used.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.show-details=never

When to show full health details.

org.springframework.boot.actuate.autoconfigure.health.HealthEndpointProperties.

management.endpoint.health.status.http-mapping=

Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200).

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoint.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

Comma-separated list of health statuses in order of severity.

org.springframework.boot.actuate.autoconfigure.health.HealthProperties$Status.

management.endpoints.enabled-by-default=

Whether to enable or disable all endpoints by default.

management.endpoints.jmx.domain=org.springframework.boot

Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.exposure.include=*

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties$Exposure.

management.endpoints.jmx.static-names=

Additional static properties to append to all ObjectNames of MBeans representing Endpoints.

org.springframework.boot.actuate.autoconfigure.endpoint.jmx.JmxEndpointProperties.

management.endpoints.jmx.unique-names=

Whether unique runtime object names should be ensured.

Deprecation status is ERROR with a replacement setting: spring.jmx.unique-names.

management.endpoints.migrate-legacy-ids=false

Whether to transparently migrate legacy endpoint IDs.

management.endpoints.web.base-path=/actuator

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.endpoints.web.cors.allow-credentials=

Whether credentials are supported. When not set, credentials are not supported.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-headers=

Comma-separated list of headers to allow in a request. '*' allows all headers.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-methods=

Comma-separated list of methods to allow. '*' allows all methods. When not set, defaults to GET.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origin-patterns=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.allowed-origins=

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.exposed-headers=

Comma-separated list of headers to include in a response.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.cors.max-age=1800s

How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used.

org.springframework.boot.actuate.autoconfigure.endpoint.web.CorsEndpointProperties.

management.endpoints.web.discovery.enabled=true

Whether the discovery page is enabled.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Discovery.

management.endpoints.web.exposure.exclude=

Endpoint IDs that should be excluded or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.exposure.include=health

Endpoint IDs that should be included or '*' for all.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties$Exposure.

management.endpoints.web.path-mapping=

Mapping between endpoint IDs and the path that should expose them.

org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties.

management.health.binders.enabled=true

Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`.

management.health.cassandra.enabled=true

Whether to enable Cassandra health check.

management.health.couchbase.enabled=true

Whether to enable Couchbase health check.

management.health.couchbase.timeout=1000ms

Timeout for getting the Bucket information from the server.

Deprecation status is ERROR without a replacement setting.

management.health.db.enabled=true

Whether to enable database health check.

management.health.db.ignore-routing-data-sources=false

Whether to ignore AbstractRoutingDataSources when creating database health indicators.

org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorProperties.

management.health.defaults.enabled=true

Whether to enable default health indicators.

management.health.diskspace.enabled=true

Whether to enable disk space health check.

management.health.diskspace.path=

Path used to compute the available disk space.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.diskspace.threshold=10MB

Minimum disk space that should be available.

org.springframework.boot.actuate.autoconfigure.system.DiskSpaceHealthIndicatorProperties.

management.health.elasticsearch.enabled=true

Whether to enable Elasticsearch health check.

management.health.elasticsearch.indices=

Comma-separated index names.

Deprecation status is ERROR without a replacement setting.

management.health.elasticsearch.response-timeout=

Time to wait for a response from the cluster.

Deprecation status is ERROR without a replacement setting.

management.health.influxdb.enabled=true

Whether to enable InfluxDB health check.

management.health.jms.enabled=true

Whether to enable JMS health check.

management.health.ldap.enabled=true

Whether to enable LDAP health check.

management.health.livenessstate.enabled=false

Whether to enable liveness state health check.

management.health.mail.enabled=true

Whether to enable Mail health check.

management.health.mongo.enabled=true

Whether to enable MongoDB health check.

management.health.neo4j.enabled=true

Whether to enable Neo4j health check.

management.health.ping.enabled=true

Whether to enable ping health check.

management.health.probes.enabled=false

Whether to enable liveness and readiness probes.

Deprecation status is WARNING with a replacement setting: management.endpoint.health.probes.enabled.

management.health.rabbit.enabled=true

Whether to enable RabbitMQ health check.

management.health.readinessstate.enabled=false

Whether to enable readiness state health check.

management.health.redis.enabled=true

Whether to enable Redis health check.

management.health.refresh.enabled=true

Enable the health endpoint for the refresh scope.

management.health.solr.enabled=true

Whether to enable Solr health check.

management.health.status.order=DOWNOUT_OF_SERVICEUPUNKNOWN

management.health.zookeeper.enabled=true

Enable the health endpoint for zookeeper.

spring.security.user.name=user

Default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.password=

Password for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

spring.security.user.roles=

Granted roles for the default user name.

org.springframework.boot.autoconfigure.security.SecurityProperties$User.

If CAS is configured to NOT enforce endpoint security rules, then all endpoints are considered sensitive and require authentication, typically handled via basic authentication with master credentials defined in CAS settings.
If CAS is configured to enforce endpoint security rules, then each endpoint may be tagged with a specific security rule allowing access via authorized IP addresses, basic credentials, roles and attributes, etc.

Defaults

There is a special endpoint named defaults which serves as a shortcut that controls the security of all endpoints, if left undefined in CAS settings.

To enable additional logging, configure the log4j configuration file to add the following levels:

<Logger name="org.pac4j" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>
<Logger name="org.springframework.security" level="debug" additivity="false">
    <AppenderRef ref="console" />
    <AppenderRef ref="file" />
</Logger>

Metrics

Metrics allow to gain insight into the running CAS software, and provide ways to measure the behavior of critical components. See this guide for more info.

Distributed Tracing

Support for distributed tracing of requests is enabled by including the following dependency in the WAR overlay:

<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-sleuth</artifactId>
  <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-sleuth:${project.'cas.version'}"

dependencyManagement {
  imports {
    mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
  }
}

dependencies {  
  implementation "org.apereo.cas:cas-server-support-sleuth"
}

For most users Sleuth should be invisible, and all interactions with external systems should be instrumented automatically.

Trace data is captured automatically and passed along to Zipkin, which helps gather timing data needed to troubleshoot latency problems.

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

spring.sleuth.async.configurer.enabled=true

Enable default AsyncConfigurer.

spring.sleuth.async.enabled=true

Enable instrumenting async related components so that the tracing information is passed between threads.

org.springframework.cloud.sleuth.autoconfig.instrument.async.SleuthAsyncProperties.

spring.sleuth.async.ignored-beans=

List of java.util.concurrent.Executor bean names that should be ignored and not wrapped in a trace representation.

org.springframework.cloud.sleuth.autoconfig.instrument.async.SleuthAsyncProperties.

spring.sleuth.baggage.correlation-enabled=true

Enables correlating the baggage context with logging contexts.

org.springframework.cloud.sleuth.autoconfig.SleuthBaggageProperties.

spring.sleuth.baggage.correlation-fields=

org.springframework.cloud.sleuth.autoconfig.SleuthBaggageProperties.

spring.sleuth.baggage.local-fields=

org.springframework.cloud.sleuth.autoconfig.SleuthBaggageProperties.

spring.sleuth.baggage.remote-fields=

List of fields that are referenced the same in-process as it is on the wire. For example, the field "x-vcap-request-id" would be set as-is including the prefix.

org.springframework.cloud.sleuth.autoconfig.SleuthBaggageProperties.

spring.sleuth.baggage.tag-fields=

org.springframework.cloud.sleuth.autoconfig.SleuthBaggageProperties.

spring.sleuth.circuitbreaker.enabled=true

Enable Spring Cloud CircuitBreaker instrumentation.

org.springframework.cloud.sleuth.autoconfig.instrument.circuitbreaker.SleuthCircuitBreakerProperties.

spring.sleuth.enabled=true

org.springframework.cloud.sleuth.autoconfig.brave.SleuthProperties.

spring.sleuth.feign.enabled=true

Enable span information propagation when using Feign.

org.springframework.cloud.sleuth.autoconfig.instrument.web.client.feign.SleuthFeignProperties.

spring.sleuth.feign.processor.enabled=true

Enable post processor that wraps Feign Context in its tracing representations.

spring.sleuth.function.enabled=true

Enable instrumenting of Spring Cloud Function and Spring Cloud Function based projects (e.g. Spring Cloud Stream).

spring.sleuth.grpc.enabled=true

Enable span information propagation when using GRPC.

spring.sleuth.http.enabled=true

Enables HTTP support.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthHttpProperties.

spring.sleuth.integration.enabled=true

Enable Spring Integration sleuth instrumentation.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthIntegrationMessagingProperties.

spring.sleuth.integration.patterns=!hystrixStreamOutput**!channel*

An array of patterns against which channel names will be matched. @see org.springframework.integration.config.GlobalChannelInterceptor#patterns() Defaults to any channel name not matching the Hystrix Stream and functional Stream channel names.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthIntegrationMessagingProperties.

spring.sleuth.integration.websockets.enabled=true

Enable tracing for WebSockets.

spring.sleuth.messaging.enabled=false

Should messaging be turned on.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthMessagingProperties.

spring.sleuth.messaging.jms.enabled=true

Enable tracing of JMS.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthMessagingProperties$Jms.

spring.sleuth.messaging.jms.remote-service-name=jms

JMS remote service name.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthMessagingProperties$Jms.

spring.sleuth.messaging.kafka.enabled=true

Enable tracing of Kafka.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthMessagingProperties$Kafka.

spring.sleuth.messaging.kafka.mapper.enabled=true

Enable DefaultKafkaHeaderMapper tracing for Kafka.

spring.sleuth.messaging.kafka.remote-service-name=kafka

Kafka remote service name.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthMessagingProperties$Kafka.

spring.sleuth.messaging.kafka.streams.enabled=false

Should Kafka Streams be turned on.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthMessagingProperties$Kafka$Streams.

spring.sleuth.messaging.rabbit.enabled=true

Enable tracing of RabbitMQ.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthMessagingProperties$Rabbit.

spring.sleuth.messaging.rabbit.remote-service-name=rabbitmq

Rabbit remote service name.

org.springframework.cloud.sleuth.autoconfig.instrument.messaging.SleuthMessagingProperties$Rabbit.

spring.sleuth.mongodb.enabled=true

Enable tracing for MongoDb.

spring.sleuth.opentracing.enabled=true

Enables OpenTracing support.

org.springframework.cloud.sleuth.autoconfig.SleuthOpentracingProperties.

spring.sleuth.propagation.type=

Tracing context propagation types.

org.springframework.cloud.sleuth.autoconfig.brave.SleuthPropagationProperties.

spring.sleuth.quartz.enabled=true

Enable tracing for Quartz.

spring.sleuth.reactor.decorate-on-each=true

When true decorates on each operator, will be less performing, but logging will always contain the tracing entries in each operator. When false decorates on last operator, will be more performing, but logging might not always contain the tracing entries. Deprecation: use explicit value via SleuthReactorProperties#instrumentationType

org.springframework.cloud.sleuth.autoconfig.instrument.reactor.SleuthReactorProperties.

Deprecation status is WARNING with a replacement setting: spring.sleuth.reactor.instrumentation-type=DECORATE_ON_EACH.

spring.sleuth.reactor.enabled=true

When true enables instrumentation for reactor.

org.springframework.cloud.sleuth.autoconfig.instrument.reactor.SleuthReactorProperties.

spring.sleuth.reactor.instrumentation-type=

org.springframework.cloud.sleuth.autoconfig.instrument.reactor.SleuthReactorProperties.

spring.sleuth.redis.enabled=true

Enable span information propagation when using Redis.

org.springframework.cloud.sleuth.autoconfig.brave.instrument.redis.TraceRedisProperties.

spring.sleuth.redis.remote-service-name=redis

Service name for the remote Redis endpoint.

org.springframework.cloud.sleuth.autoconfig.brave.instrument.redis.TraceRedisProperties.

spring.sleuth.rpc.enabled=true

Enable tracing of RPC.

spring.sleuth.rxjava.schedulers.hook.enabled=true

Enable support for RxJava via RxJavaSchedulersHook.

org.springframework.cloud.sleuth.autoconfig.instrument.rxjava.SleuthRxJavaSchedulersProperties$Hook.

spring.sleuth.rxjava.schedulers.ignoredthreads=HystrixMetricPoller^RxComputation.*$

Thread names for which spans will not be sampled.

org.springframework.cloud.sleuth.autoconfig.instrument.rxjava.SleuthRxJavaSchedulersProperties.

spring.sleuth.sampler.probability=

Probability of requests that should be sampled. E.g. 1.0 - 100% requests should be sampled. The precision is whole-numbers only (i.e. there's no support for 0.1% of the traces).

org.springframework.cloud.sleuth.autoconfig.brave.SamplerProperties.

spring.sleuth.sampler.rate=10

A rate per second can be a nice choice for low-traffic endpoints as it allows you surge protection. For example, you may never expect the endpoint to get more than 50 requests per second. If there was a sudden surge of traffic, to 5000 requests per second, you would still end up with 50 traces per second. Conversely, if you had a percentage, like 10%, the same surge would end up with 500 traces per second, possibly overloading your storage. Amazon X-Ray includes a rate-limited sampler (named Reservoir) for this purpose. Brave has taken the same approach via the brave.sampler.RateLimitingSampler.

org.springframework.cloud.sleuth.autoconfig.brave.SamplerProperties.

spring.sleuth.sampler.refresh.enabled=true

Enable refresh scope for sampler.

spring.sleuth.scheduled.enabled=true

Enable tracing for org.springframework.scheduling.annotation.Scheduled.

org.springframework.cloud.sleuth.autoconfig.instrument.scheduling.SleuthSchedulingProperties.

spring.sleuth.scheduled.skip-pattern=

Pattern for the fully qualified name of a class that should be skipped.

org.springframework.cloud.sleuth.autoconfig.instrument.scheduling.SleuthSchedulingProperties.

spring.sleuth.span-filter.additional-span-name-patterns-to-ignore=

Additional list of span names to ignore. Will be appended to #spanNamePatternsToSkip.

org.springframework.cloud.sleuth.autoconfig.SleuthSpanFilterProperties.

spring.sleuth.span-filter.enabled=false

Will turn on the default Sleuth handler mechanism. Might ignore exporting of certain spans;

org.springframework.cloud.sleuth.autoconfig.SleuthSpanFilterProperties.

spring.sleuth.span-filter.span-name-patterns-to-skip=^catalogWatchTaskScheduler$

List of span names to ignore. They will not be sent to external systems.

org.springframework.cloud.sleuth.autoconfig.SleuthSpanFilterProperties.

spring.sleuth.supports-join=true

True means the tracing system supports sharing a span ID between a client and server.

org.springframework.cloud.sleuth.autoconfig.brave.SleuthProperties.

spring.sleuth.trace-id128=false

When true, generate 128-bit trace IDs instead of 64-bit ones.

org.springframework.cloud.sleuth.autoconfig.brave.SleuthProperties.

spring.sleuth.tracer.mode=

Set which tracer implementation should be picked.

org.springframework.cloud.sleuth.autoconfig.SleuthTracerProperties.

spring.sleuth.web.additional-skip-pattern=

Additional pattern for URLs that should be skipped in tracing. This will be appended to the SleuthWebProperties#skipPattern.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthWebProperties.

spring.sleuth.web.client.enabled=true

Enable interceptor injecting into org.springframework.web.client.RestTemplate.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthWebProperties$Client.

spring.sleuth.web.client.skip-pattern=

Pattern for URLs that should be skipped in client side tracing.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthWebProperties$Client.

spring.sleuth.web.enabled=true

When true enables instrumentation for web applications.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthWebProperties.

spring.sleuth.web.filter-order=0

Order in which the tracing filters should be registered.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthWebProperties.

spring.sleuth.web.ignore-auto-configured-skip-patterns=false

If set to true, auto-configured skip patterns will be ignored.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthWebProperties.

spring.sleuth.web.servlet.enabled=true

Enable servlet instrumentation.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthWebProperties$Servlet.

Pattern for URLs that should be skipped in tracing.

org.springframework.cloud.sleuth.autoconfig.instrument.web.SleuthWebProperties.

spring.sleuth.web.webclient.enabled=true

Enable tracing instrumentation for WebClient.

spring.zipkin.activemq.message-max-bytes=100000

Maximum number of bytes for a given message with spans sent to Zipkin over ActiveMQ.

spring.zipkin.activemq.queue=zipkin

Name of the ActiveMQ queue where spans should be sent to Zipkin.

spring.zipkin.api-path=

The API path to append to baseUrl (above) as suffix. This applies if you use other monitoring tools, such as New Relic. The trace API doesn't need the API path, so you can set it to blank ("") in the configuration.

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties.

spring.zipkin.base-url=http://localhost:9411/

URL of the zipkin query server instance. You can also provide the service id of the Zipkin server if Zipkin's registered in service discovery (e.g. https://zipkinserver/).

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties.

spring.zipkin.compression.enabled=false

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties$Compression.

spring.zipkin.discovery-client-enabled=

If set to false, will treat the ZipkinProperties#baseUrl as a URL always.

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties.

spring.zipkin.enabled=true

Enables sending spans to Zipkin.

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties.

spring.zipkin.encoder=

Encoding type of spans sent to Zipkin. Set to SpanBytesEncoder#JSON_V1 if your server is not recent.

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties.

spring.zipkin.kafka.topic=zipkin

Name of the Kafka topic where spans should be sent to Zipkin.

spring.zipkin.locator.discovery.enabled=false

Enabling of locating the host name via service discovery.

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties$Locator$Discovery.

spring.zipkin.message-timeout=1

Timeout in seconds before pending spans will be sent in batches to Zipkin.

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties.

spring.zipkin.rabbitmq.addresses=

Addresses of the RabbitMQ brokers used to send spans to Zipkin

spring.zipkin.rabbitmq.queue=zipkin

Name of the RabbitMQ queue where spans should be sent to Zipkin.

spring.zipkin.sender.type=

Means of sending spans to Zipkin.

org.springframework.cloud.sleuth.autoconfig.zipkin2.ZipkinSenderProperties.

spring.zipkin.service.name=

The name of the service, from which the Span was sent via HTTP, that should appear in Zipkin.

org.springframework.cloud.sleuth.zipkin2.ZipkinProperties$Service.

# Enable default AsyncConfigurer.
# spring.sleuth.async.configurer.enabled=true

# Enable instrumenting async related components so that the tracing information is passed between threads.
# spring.sleuth.async.enabled=true

# List of {@link java.util.concurrent.Executor} bean names that should be ignored and not wrapped in a trace representation.
# spring.sleuth.async.ignored-beans=

# Enables correlating the baggage context with logging contexts.
# spring.sleuth.baggage.correlation-enabled=true

# 
# spring.sleuth.baggage.correlation-fields=

# 
# spring.sleuth.baggage.local-fields=

# List of fields that are referenced the same in-process as it is on the wire.
# spring.sleuth.baggage.remote-fields=

# 
# spring.sleuth.baggage.tag-fields=

# Enable Spring Cloud CircuitBreaker instrumentation.
# spring.sleuth.circuitbreaker.enabled=true

# 
# spring.sleuth.enabled=true

# Enable span information propagation when using Feign.
# spring.sleuth.feign.enabled=true

# Enable post processor that wraps Feign Context in its tracing representations.
# spring.sleuth.feign.processor.enabled=true

# Enable instrumenting of Spring Cloud Function and Spring Cloud Function based projects (e.g.
# spring.sleuth.function.enabled=true

# Enable span information propagation when using GRPC.
# spring.sleuth.grpc.enabled=true

# Enables HTTP support.
# spring.sleuth.http.enabled=true

# Enable Spring Integration sleuth instrumentation.
# spring.sleuth.integration.enabled=true

# An array of patterns against which channel names will be matched.
# spring.sleuth.integration.patterns=["!hystrixStreamOutput*", "*", "!channel*"]

# Enable tracing for WebSockets.
# spring.sleuth.integration.websockets.enabled=true

# Should messaging be turned on.
# spring.sleuth.messaging.enabled=false

# Enable tracing of JMS.
# spring.sleuth.messaging.jms.enabled=true

# JMS remote service name.
# spring.sleuth.messaging.jms.remote-service-name=jms

# Enable tracing of Kafka.
# spring.sleuth.messaging.kafka.enabled=true

# Enable DefaultKafkaHeaderMapper tracing for Kafka.
# spring.sleuth.messaging.kafka.mapper.enabled=true

# Kafka remote service name.
# spring.sleuth.messaging.kafka.remote-service-name=kafka

# Should Kafka Streams be turned on.
# spring.sleuth.messaging.kafka.streams.enabled=false

# Enable tracing of RabbitMQ.
# spring.sleuth.messaging.rabbit.enabled=true

# Rabbit remote service name.
# spring.sleuth.messaging.rabbit.remote-service-name=rabbitmq

# Enable tracing for MongoDb.
# spring.sleuth.mongodb.enabled=true

# Enables OpenTracing support.
# spring.sleuth.opentracing.enabled=true

# Tracing context propagation types.
# spring.sleuth.propagation.type=

# Enable tracing for Quartz.
# spring.sleuth.quartz.enabled=true

# When true decorates on each operator, will be less performing, but logging will always contain the tracing entries in each operator.
# spring.sleuth.reactor.decorate-on-each=true

# When true enables instrumentation for reactor.
# spring.sleuth.reactor.enabled=true

# 
# spring.sleuth.reactor.instrumentation-type=

# Enable span information propagation when using Redis.
# spring.sleuth.redis.enabled=true

# Service name for the remote Redis endpoint.
# spring.sleuth.redis.remote-service-name=redis

# Enable tracing of RPC.
# spring.sleuth.rpc.enabled=true

# Enable support for RxJava via RxJavaSchedulersHook.
# spring.sleuth.rxjava.schedulers.hook.enabled=true

# Thread names for which spans will not be sampled.
# spring.sleuth.rxjava.schedulers.ignoredthreads=["HystrixMetricPoller", "^RxComputation.*$"]

# Probability of requests that should be sampled.
# spring.sleuth.sampler.probability=

# A rate per second can be a nice choice for low-traffic endpoints as it allows you surge protection.
# spring.sleuth.sampler.rate=10

# Enable refresh scope for sampler.
# spring.sleuth.sampler.refresh.enabled=true

# Enable tracing for {@link org.springframework.scheduling.annotation.Scheduled}.
# spring.sleuth.scheduled.enabled=true

# Pattern for the fully qualified name of a class that should be skipped.
# spring.sleuth.scheduled.skip-pattern=

# Additional list of span names to ignore.
# spring.sleuth.span-filter.additional-span-name-patterns-to-ignore=

# Will turn on the default Sleuth handler mechanism.
# spring.sleuth.span-filter.enabled=false

# List of span names to ignore.
# spring.sleuth.span-filter.span-name-patterns-to-skip=^catalogWatchTaskScheduler$

# True means the tracing system supports sharing a span ID between a client and server.
# spring.sleuth.supports-join=true

# When true, generate 128-bit trace IDs instead of 64-bit ones.
# spring.sleuth.trace-id128=false

# Set which tracer implementation should be picked.
# spring.sleuth.tracer.mode=

# Additional pattern for URLs that should be skipped in tracing.
# spring.sleuth.web.additional-skip-pattern=

# Enable interceptor injecting into {@link org.springframework.web.client.RestTemplate}.
# spring.sleuth.web.client.enabled=true

# Pattern for URLs that should be skipped in client side tracing.
# spring.sleuth.web.client.skip-pattern=

# When true enables instrumentation for web applications.
# spring.sleuth.web.enabled=true

# Order in which the tracing filters should be registered.
# spring.sleuth.web.filter-order=0

# If set to true, auto-configured skip patterns will be ignored.
# spring.sleuth.web.ignore-auto-configured-skip-patterns=false

# Enable servlet instrumentation.
# spring.sleuth.web.servlet.enabled=true

# Pattern for URLs that should be skipped in tracing.
# spring.sleuth.web.skip-pattern=/api-docs.*|/swagger.*|.*\.png|.*\.css|.*\.js|.*\.html|/favicon.ico|/hystrix.stream

# Enable tracing instrumentation for WebClient.
# spring.sleuth.web.webclient.enabled=true

# Maximum number of bytes for a given message with spans sent to Zipkin over ActiveMQ.
# spring.zipkin.activemq.message-max-bytes=100000

# Name of the ActiveMQ queue where spans should be sent to Zipkin.
# spring.zipkin.activemq.queue=zipkin

# The API path to append to baseUrl (above) as suffix.
# spring.zipkin.api-path=

# URL of the zipkin query server instance.
# spring.zipkin.base-url=http://localhost:9411/

# 
# spring.zipkin.compression.enabled=false

# If set to {@code false}, will treat the {@link ZipkinProperties#baseUrl} as a URL always.
# spring.zipkin.discovery-client-enabled=

# Enables sending spans to Zipkin.
# spring.zipkin.enabled=true

# Encoding type of spans sent to Zipkin.
# spring.zipkin.encoder=

# Name of the Kafka topic where spans should be sent to Zipkin.
# spring.zipkin.kafka.topic=zipkin

# Enabling of locating the host name via service discovery.
# spring.zipkin.locator.discovery.enabled=false

# Timeout in seconds before pending spans will be sent in batches to Zipkin.
# spring.zipkin.message-timeout=1

# Addresses of the RabbitMQ brokers used to send spans to Zipkin
# spring.zipkin.rabbitmq.addresses=

# Name of the RabbitMQ queue where spans should be sent to Zipkin.
# spring.zipkin.rabbitmq.queue=zipkin

# Means of sending spans to Zipkin.
# spring.zipkin.sender.type=

# The name of the service, from which the Span was sent via HTTP, that should appear in Zipkin.
# spring.zipkin.service.name=

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.S ettings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

Troubleshooting

To enable additional logging, modify the logging configuration file to add the following:

 <Logger name="org.springframework.cloud" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>

Enterprise Single Sign-On for All

Monitoring / Statistics

Actuator Endpoints

LDAP Scriptable Search Filter

Metrics

Distributed Tracing

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

Troubleshooting